org.springframework.test.web.servlet.htmlunit

Class MockMvcWebConnection

java.lang.Object

org.springframework.test.web.servlet.htmlunit.MockMvcWebConnection

public final class MockMvcWebConnection
extends java.lang.Object

MockMvcWebConnection enables MockMvc to transform a WebRequest into a WebResponse.

This is the core integration with HtmlUnit.

Example usage can be seen below.

 WebClient webClient = new WebClient();
 MockMvc mockMvc = ...
 MockMvcWebConnection webConnection = new MockMvcWebConnection(mockMvc, webClient);
 webClient.setWebConnection(webConnection);

 // Use webClient as normal ...
 

Since:

4.2

Author:

Rob Winch, Sam Brannen

See Also:

WebConnectionHtmlUnitDriver

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	contextPath
private MockMvc	mockMvc
private java.util.Map<java.lang.String,MockHttpSession>	sessions
private WebClient	webClient

Constructor Summary

Constructors

Constructor and Description
MockMvcWebConnection(MockMvc mockMvc) Deprecated. Use MockMvcWebConnection(MockMvc, WebClient)
MockMvcWebConnection(MockMvc mockMvc, WebClient webClient) Create a new instance that assumes the context path of the application is "" (i.e., the root context).
MockMvcWebConnection(MockMvc mockMvc, WebClient webClient, java.lang.String contextPath) Create a new instance with the specified context path.

Method Summary

Modifier and Type	Method and Description
void	close()
WebResponse	getResponse(WebRequest webRequest)
void	setWebClient(WebClient webClient)
(package private) static void	validateContextPath(java.lang.String contextPath) Validate the supplied contextPath.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sessions

private final java.util.Map<java.lang.String,MockHttpSession> sessions

mockMvc

private final MockMvc mockMvc

contextPath

private final java.lang.String contextPath

webClient

private WebClient webClient

Constructor Detail

MockMvcWebConnection

public MockMvcWebConnection(MockMvc mockMvc,
                            WebClient webClient)

Create a new instance that assumes the context path of the application is "" (i.e., the root context).

For example, the URL http://localhost/test/this would use "" as the context path.

Parameters:

mockMvc - the MockMvc instance to use; never null

webClient - the WebClient to use. never null

MockMvcWebConnection

public MockMvcWebConnection(MockMvc mockMvc,
                            WebClient webClient,
                            java.lang.String contextPath)

Create a new instance with the specified context path.

The path may be null in which case the first path segment of the URL is turned into the contextPath. Otherwise it must conform to javax.servlet.http.HttpServletRequest#getContextPath() which states that it can be an empty string and otherwise must start with a "/" character and not end with a "/" character.

Parameters:

mockMvc - the MockMvc instance to use; never null

webClient - the WebClient to use. never null

contextPath - the contextPath to use

MockMvcWebConnection

@Deprecated
public MockMvcWebConnection(MockMvc mockMvc)

Deprecated. Use MockMvcWebConnection(MockMvc, WebClient)

Create a new instance that assumes the context path of the application is "" (i.e., the root context).

For example, the URL http://localhost/test/this would use "" as the context path.

Parameters:

mockMvc - the MockMvc instance to use; never null

Method Detail

setWebClient

public void setWebClient(WebClient webClient)

getResponse

public WebResponse getResponse(WebRequest webRequest)
                        throws java.io.IOException

Throws:

java.io.IOException

close

public void close()

validateContextPath

static void validateContextPath(java.lang.String contextPath)

Validate the supplied contextPath.

If the value is not null, it must conform to javax.servlet.http.HttpServletRequest#getContextPath() which states that it can be an empty string and otherwise must start with a "/" character and not end with a "/" character.

Parameters:

contextPath - the path to validate